Conversation
- only build docs for PRs and pushes to main - only deploys docs from main branch
Contributor
WalkthroughRestricts MkDocs deploy workflow triggers to the main branch for push and pull_request events and retains manual workflow_dispatch. No job or deployment step changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/workflows/mkdocs-deploy.yml (2)
3-8: Avoid wasted CI by canceling superseded runsAdd a concurrency group so newer pushes/PR updates cancel in-flight doc builds.
name: MkDocs Deploy on: push: branches: [main] pull_request: branches: [main] workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true
10-12: Skip builds for draft PRs (run when marked ready)Prevents building docs for drafts; it will build automatically on ready_for_review.
jobs: build-docs: + if: github.event_name != 'pull_request' || github.event.pull_request.draft == false uses: cpp-linter/.github/.github/workflows/mkdocs.yml@main
shenxianpeng
approved these changes
Sep 7, 2025
shenxianpeng
added
developer
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
This is really just designed to stop building docs on every push to every branch.
Summary by CodeRabbit